Fix TS definitions #43

iamakulov · 2020-06-15T22:46:26Z

The source code uses module.exports = ..., not exports.default = ...:

Lines 14 to 22 in 9d8313d

    
           module.exports = function cleanDeep(object, { 
        
             cleanKeys = [], 
        
             cleanValues = [], 
        
             emptyArrays = true, 
        
             emptyObjects = true, 
        
             emptyStrings = true, 
        
             nullValues = true, 
        
             undefinedValues = true 
        
           } = {}) {

Given this, TS definitions should use export =, not export default. See microsoft/TypeScript#7185 (comment).

This matters when the project is compiled without the "esModuleInterop": true flag. In that case, doing

import cleanDeep from 'clean-deep'

cleanDeep(...)

would throw an error like TypeError: clean_deep_1.default is not a function.

The source code uses `module.exports = ...`, not `exports.default = ...`: https://github.com/nunofgs/clean-deep/blob/9d8313db868b239b990f9db352215844ad7ae65a/src/index.js#L14-L22 Given this, TS definitions should use `export =`, not `export default`. See microsoft/TypeScript#7185 (comment). This matters when the project is compiled _without_ the `"esModuleInterop": true` flag. In that case, doing ```ts import cleanDeep from 'clean-deep' cleanDeep(...) ``` would throw an error like `TypeError: clean_deep_1.default is not a function`.

FFKL · 2020-06-25T09:54:42Z

@iamakulov cool! What about CleanOptions? Should be moved intonamespace?

iamakulov · 2020-06-26T03:14:19Z

What about CleanOptions? Should be moved intonamespace?

Dunno. Why?

FFKL · 2020-06-26T14:24:58Z

Because you overwright exports object by the cleanDeep function and can't use export = with other exports. example

nunofgs · 2020-08-19T22:18:02Z

Good point @FFKL . Not sure this can be achieved with the = syntax since you can't really export two things as the "default"
(ultimately they need to be attached somewhere).

Closing for now but please do reopen if you have other suggestions. Thanks!

nunofgs closed this Aug 19, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix TS definitions #43

Fix TS definitions #43

iamakulov commented Jun 15, 2020

FFKL commented Jun 25, 2020 •

edited

Loading

iamakulov commented Jun 26, 2020

FFKL commented Jun 26, 2020

nunofgs commented Aug 19, 2020

	module.exports = function cleanDeep(object, {
	cleanKeys = [],
	cleanValues = [],
	emptyArrays = true,
	emptyObjects = true,
	emptyStrings = true,
	nullValues = true,
	undefinedValues = true
	} = {}) {

Fix TS definitions #43

Fix TS definitions #43

Conversation

iamakulov commented Jun 15, 2020

FFKL commented Jun 25, 2020 • edited Loading

iamakulov commented Jun 26, 2020

FFKL commented Jun 26, 2020

nunofgs commented Aug 19, 2020

FFKL commented Jun 25, 2020 •

edited

Loading